<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>OrbbecSDK: /root/libobsensor/include/libobsensor/h/Error.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="orbbec_icon.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">OrbbecSDK
   &#160;<span id="projectnumber">1.10.22</span>
   </div>
   <div id="projectbrief">OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_8195f5c0d9a800b311ff87242d342361.html">libobsensor</a></li><li class="navelem"><a class="el" href="dir_9fda3634bd985c8b3aac4c1dd5078468.html">h</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">Error.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="Error_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;</div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;</div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="ObTypes_8h.html">ObTypes.h</a>&quot;</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<a class="code" href="ObTypes_8h.html#a2d4caae302682fc3cb8f8034bb99e229">ob_status</a> <a class="code" href="Error_8h.html#a52a52f63a64672df1716167876bd492c">ob_error_status</a>(<a class="code" href="structob__error.html">ob_error</a> *error);</div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="Error_8h.html#a00a287f6ac69c3fd7a17aab13f6e54fb">ob_error_message</a>(<span class="keyword">const</span> <a class="code" href="structob__error.html">ob_error</a> *error);</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="Error_8h.html#a1365826f2864b92af351a1e3b6c7d10d">ob_error_function</a>(<a class="code" href="structob__error.html">ob_error</a> *error);</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="Error_8h.html#aa75bb01051d5e973475cfb6c9c48515d">ob_error_args</a>(<a class="code" href="structob__error.html">ob_error</a> *error);</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<a class="code" href="ObTypes_8h.html#ad131bb94383fdce36cb8aa91de5e0560">ob_exception_type</a> <a class="code" href="Error_8h.html#a6218df5b2497f1f1fcca55a8214a51c4">ob_error_exception_type</a>(<a class="code" href="structob__error.html">ob_error</a> *error);</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="keywordtype">void</span> <a class="code" href="Error_8h.html#afc7c11095b7700c93427cd63747e15f8">ob_delete_error</a>(<a class="code" href="structob__error.html">ob_error</a> *error);</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;}</div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="Error_8h_html_a6218df5b2497f1f1fcca55a8214a51c4"><div class="ttname"><a href="Error_8h.html#a6218df5b2497f1f1fcca55a8214a51c4">ob_error_exception_type</a></div><div class="ttdeci">ob_exception_type ob_error_exception_type(ob_error *error)</div><div class="ttdoc">Get the type of exception that caused the error. </div></div>
<div class="ttc" id="ObTypes_8h_html"><div class="ttname"><a href="ObTypes_8h.html">ObTypes.h</a></div><div class="ttdoc">Provide structs commonly used in the SDK, enumerating constant definitions. </div></div>
<div class="ttc" id="ObTypes_8h_html_ad131bb94383fdce36cb8aa91de5e0560"><div class="ttname"><a href="ObTypes_8h.html#ad131bb94383fdce36cb8aa91de5e0560">ob_exception_type</a></div><div class="ttdeci">enum OBExceptionType ob_exception_type</div></div>
<div class="ttc" id="Error_8h_html_aa75bb01051d5e973475cfb6c9c48515d"><div class="ttname"><a href="Error_8h.html#aa75bb01051d5e973475cfb6c9c48515d">ob_error_args</a></div><div class="ttdeci">const char * ob_error_args(ob_error *error)</div><div class="ttdoc">Get the error parameters. </div></div>
<div class="ttc" id="Error_8h_html_a1365826f2864b92af351a1e3b6c7d10d"><div class="ttname"><a href="Error_8h.html#a1365826f2864b92af351a1e3b6c7d10d">ob_error_function</a></div><div class="ttdeci">const char * ob_error_function(ob_error *error)</div><div class="ttdoc">Get the name of the API function that caused the error. </div></div>
<div class="ttc" id="Error_8h_html_a00a287f6ac69c3fd7a17aab13f6e54fb"><div class="ttname"><a href="Error_8h.html#a00a287f6ac69c3fd7a17aab13f6e54fb">ob_error_message</a></div><div class="ttdeci">const char * ob_error_message(const ob_error *error)</div><div class="ttdoc">Get the error message. </div></div>
<div class="ttc" id="Error_8h_html_a52a52f63a64672df1716167876bd492c"><div class="ttname"><a href="Error_8h.html#a52a52f63a64672df1716167876bd492c">ob_error_status</a></div><div class="ttdeci">ob_status ob_error_status(ob_error *error)</div><div class="ttdoc">Get the error status. </div></div>
<div class="ttc" id="Error_8h_html_afc7c11095b7700c93427cd63747e15f8"><div class="ttname"><a href="Error_8h.html#afc7c11095b7700c93427cd63747e15f8">ob_delete_error</a></div><div class="ttdeci">void ob_delete_error(ob_error *error)</div><div class="ttdoc">Delete the error object. </div></div>
<div class="ttc" id="ObTypes_8h_html_a2d4caae302682fc3cb8f8034bb99e229"><div class="ttname"><a href="ObTypes_8h.html#a2d4caae302682fc3cb8f8034bb99e229">ob_status</a></div><div class="ttdeci">enum OBStatus ob_status</div></div>
<div class="ttc" id="structob__error_html"><div class="ttname"><a href="structob__error.html">ob_error</a></div><div class="ttdoc">The error class exposed by the SDK, users can get detailed error information according to the error...</div><div class="ttdef"><b>Definition:</b> <a href="ObTypes_8h_source.html#l00151">ObTypes.h:151</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Apr 10 2025 12:28:22 for OrbbecSDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
